<html dir="ltr">
	<head>
		<title>Testing NDocBuilder</title>
		<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
		<meta content="http://schemas.microsoft.com/intellisense/ie5" name="vs_targetSchema">
		<xml></xml><LINK href="MSDN.css" type="text/css" rel="stylesheet">
		<script language="javascript">
		function openNewWindow(strUrl){window.open(strUrl, '_blank');} // Open the given url in a new window
		</script>
	</head>
	<body class="dtBODY" id="bodyID">
		<div id="nsbanner">
			<div id="bannerrow1">
				<table class="bannerparthead" id="Table1" cellSpacing="0">
					<tr id="hdr">
						<td class="runninghead">NDocBuilder Documentation</td>
						<td class="product"></td>
					</tr>
				</table>
			</div>
			<div id="TitleRow">
				<h1 class="dtH1">NDocBuilder</h1>
			</div>
		</div>
		<div id="nstext">
			<p>	<h3 class="dtH3" id="Testing_NDocBuilder">Testing NDocBuilder</h3>
				<ul>
					<li>
						<p>Start Visual Studio and create a new C# console project</p>
						<p><IMG src="NewConsoleApplication.gif"></p>
					<li>
						<p>To create the XML documentation you will need to specify a filename in the 
							project properties.<br>
							Make sure the active configuration is set to debug.<br>
							Go to menu <i>Project</i> -&gt; <i>Properties</i> to open the property pages.<br>
							Open <i>Configuration Properties</i> -&gt; <i>Build</i> on the left side and 
							enter a filename in the "<i>XML Documentation File</i>" field.<br>
						</p>
						<IMG src="ProjectPropertiesXmlDoc.gif"><br>
						<p>Any filename will do as long as its a relative path.</p>
					<li>
						<p>The standard <i>Class1.cs</i> will look something like this:
							<pre><FONT color=#0000ff>using</FONT> System;

<FONT color=#0000ff>namespace</FONT> NDocBuilderTestConsoleApp
{
	<FONT color=gray>/// &lt;summary&gt;</FONT>
	<FONT color=gray>///</FONT> <FONT color=green>Summary description for Class1.</FONT>
	<FONT color=gray>/// &lt;/summary&gt;</FONT>
	<FONT color=#0000ff>class</FONT> Class1
	{
		<FONT color=gray>/// &lt;summary&gt;</FONT>
		<FONT color=gray>/// </FONT><FONT color=green>The main entry point for the application.</FONT>
		<FONT color=gray>/// &lt;/summary&gt;</FONT>
		[STAThread]
		<FONT color=#0000ff>static void</FONT> Main(<FONT color=#0000ff>string</FONT>[] args)
		{
			<FONT color=green>//
			// TODO: Add code to start application here
			//</FONT>
		}
	}
}
							</pre>
							The comments between the <i>summary</i> tags is added to the documentation.<br>
							Since NDoc will by default not create documentation for <i>internal</i> and <i>private</i>
							objects change the line "<i>class Class1</i>" to "<i>public class Class1</i>".<br>
						Create the XML documentation file by building the project.
						<P></P>
					<li>
						<p>
							If the NDocBuilder plugin is installed correctly you'll see the option <i>NDocBuilder</i>
							under the menu <i>Tools</i>.
						</p>
						<p>
							<img src="ToolsNDocBuilder.gif" border="1">
						</p>
					<li>
						<p>
							Select <i>NDocBuilder</i> from the <i>Tools</i> menu.<br>
							The plugin will check if it can find the required assembly and xml 
							documentation. If those are available it will compile the documentation.
						</p>
					<li>
						<p>
							When NDoc has finished compiling, both the NDoc project file and the 
							documentation file are added to the project under the <i>Documentation</i> folder.
						</p>
						<p>
							<img src="ProjectDocumentationFolder.gif" border="1">
						</p>
						<p>
							You can open the <i>Chm</i> file by double clicking on it.
						</p>
					</li>
				</ul>
				
			<P></P>
			<hr>
			<div id="footer">
				<p>
				</p>
				<p>
				</p>
			</div>
		</div>
	</body>
</html>
